ノード識別子によるナビゲーションの取得
get
/resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier}
リソース・エンドポイントは、サイト名の指定されたノード識別子のナビゲーション・データを返します。
重要な注意: これは、単数リソースです。レスポンスの形式は、集約されたアセット形式です(「アセット・リソース・エンドポイント」の注意を参照してください)。アセット情報に加えてナビゲーション・データも含まれる点を除き、アセット・リソース・エンドポイントに似ています。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields、segments、profileName)はこのリソースにも適用されます。ナビゲーション・データ(ナビゲーションに関する子ノード)はすべて、レスポンスの'children'配列で提供されます。各子もまた集約されたアセットです。指定した集約アセット問合せパラメータは子配列の各子にも適用されます。
重要な注意: これは、単数リソースです。レスポンスの形式は、集約されたアセット形式です(「アセット・リソース・エンドポイント」の注意を参照してください)。アセット情報に加えてナビゲーション・データも含まれる点を除き、アセット・リソース・エンドポイントに似ています。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields、segments、profileName)はこのリソースにも適用されます。ナビゲーション・データ(ナビゲーションに関する子ノード)はすべて、レスポンスの'children'配列で提供されます。各子もまた集約されたアセットです。指定した集約アセット問合せパラメータは子配列の各子にも適用されます。
次の表に、クライアント・リクエストをまとめます。
パス・パラメータ
| 名前 | 説明 | 形式 |
|---|---|---|
| nodeIdentifier | サイト・ノードIDまたはサイト・ナビゲーション名 | 整数 double |
| siteName | サイトの名前 | 文字列 |
問合せパラメータ
| 名前 | 説明 | 形式 |
|---|---|---|
| assetDepth | このパラメータの詳細は、「アセット・リソース」の'assetDepth'問合せパラメータを参照してください。子配列の各子にも適用されます。 | 数値 |
| code | サイト・ノード・タイプのカンマ区切りのリストを受け入れます。パブリケーション下の配置された子ノード(ページ)を返すか、配置されていない子ノードを返すかを決定します。デフォルト・ノード・タイプは、placedです。これは、パブリケーション・ノード(つまり、nodeIdentifierがパブリケーションID)にのみ適用されます。 使用方法:
|
文字列 |
| expand | assetTypeのカンマ区切りのリストを受け入れます。このパラメータの詳細は、「アセット・リソース」の'expand'問合せパラメータを参照してください。子配列の各子にも適用されます。 | 文字列 |
| fields | このパラメータの詳細は、「アセット・リソース」の'fields'問合せパラメータを参照してください。子配列の各子にも適用されます。'children'配列は、レスポンスから除外できません。 | 文字列 |
| links | リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(schema、selfおよびcanonicalリソース)が返されます。 | 文字列 |
| navigationDepth | 任意の正の整数または文字列"all"を受け入れます。整数のナビゲーションの深さで、どの子レベルまでサイト・ナビゲーションをトラバースするかを定義します。文字列"all"は全体のことです。デフォルト値は2です。navigationDepth値が無効(負の数値)の場合、デフォルトのnavigationDepth値が使用されます。ノードの子は、子配列で提供されます。この子属性は除外できません。各子アイテムもまた集約されており、集約されたアセットの問合せパラメータはすべて各アイテムに適用できます。 | 数値 |
| profileName | このパラメータの詳細は、「アセット・リソース」の'profileName'問合せパラメータを参照してください。子配列の各子にも適用されます。 | 文字列 |
| segments | このパラメータの詳細は、「アセット・リソース」の'segments'問合せパラメータを参照してください。子配列の各子にも適用されます。 | 文字列 |
次の表に、サーバー・レスポンスをまとめます。
サポートされるメディア・タイプ
- application/json
200レスポンス
集約された形式のサイト・ナビゲーション・データ
例1
次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトのホーム・ページ直下のすべての子ページの名前およびIDを取得する方法を示します。
問合せパラメータの詳細:
"navigationDepth=1": 直下の子のみ必要です。
"assetDepth=0&fields=Page(name,id)": すべての子が'children'配列で提供されます。各子(ページ)は集約されたアセットです。子の名前のみ必要です。
curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/1327351719456?navigationDepth=1&assetDepth=0&fields=Page(name,id)"
例1 レスポンス・ヘッダー
次の例に、レスポンス・ヘッダーを示します。
HTTP/1.1 200 OK ETag: "ca4e0e90bb39936eaa6681b2a8c44bdf2933a84e06faae275f28e7378e204f04" Cache-Control: max-age=0 Content-Type: application/json;charset=utf-8
例1 レスポンス本文
次の例に、JSON形式のレスポンス本文のコンテンツを示します。
{
"start": "Page:1327351719456",
"links": [
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/1327351719456?navigationDepth=1&fields=Page(name,id)&assetDepth=0",
"rel": "self",
"templated": false,
"mediaType": "",
"method": "",
"profile": ""
},
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/1327351719456?navigationDepth=1&fields=Page(name,id)&assetDepth=0",
"rel": "canonical",
"templated": false,
"mediaType": "",
"method": "",
"profile": ""
},
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation/1327351719456",
"rel": "describedby",
"templated": false,
"mediaType": "application/schema+json",
"method": "GET",
"profile": ""
}
],
"Page:1327351719456": {
"name": "Home",
"id": 1327351719456,
"children": [
{
"Page:1329851332601": {
"name": "Surfing",
"id": 1329851332601,
"parents": []
},
"start": "Page:1329851332601"
},
{
"Page:1329326970440": {
"name": "Skiing",
"id": 1329326970440,
"parents": []
},
"start": "Page:1329326970440"
},
{
"Page:1361217259137": {
"name": "Running",
"id": 1361217259137,
"parents": []
},
"start": "Page:1361217259137"
},
{
"start": "Page:1327351719467",
"Page:1327351719467": {
"name": "Tennis",
"id": 1327351719467,
"parents": []
}
},
{
"start": "Page:1327351719525",
"Page:1327351719525": {
"name": "Baseball",
"id": 1327351719525,
"parents": []
}
}
],
"parents": []
}
}
例2
次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトのデフォルトsiteNavigation下の階層のすべて子ページ名を取得する方法を示します。
問合せパラメータの詳細:
"navigationDepth=all": 階層内のすべての子が必要です。
"assetDepth=0&fields=SiteNavigation(name)": すべての子が'children'配列で提供されます。各子(ページ)は集約されたアセットです。子の名前のみ必要です。
curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/default?navigationDepth=all&assetDepth=0&fields=SiteNavigation(name);Page(name)"
例2 レスポンス・ヘッダー
次の例に、レスポンス・ヘッダーを示します。
HTTP/1.1 200 OK ETag: "231b40a9fcbc77e9b6db18fe8fd87a5a4c552ff54ad5d291cdd6c8a811337529" Cache-Control: max-age=0 Content-Type: application/json;charset=utf-8
例2 レスポンス本文
次の例に、JSON形式のレスポンス本文のコンテンツを示します。
{
"start": "SiteNavigation:1052581735",
"links": [
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/default?navigationDepth=all&fields=SiteNavigation(name);Page(name)&assetDepth=0",
"rel": "self",
"templated": false,
"mediaType": "",
"method": "",
"profile": ""
},
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation/default?navigationDepth=all&fields=SiteNavigation(name);Page(name)&assetDepth=0",
"rel": "canonical",
"templated": false,
"mediaType": "",
"method": "",
"profile": ""
},
{
"href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation/default",
"rel": "describedby",
"templated": false,
"mediaType": "application/schema+json",
"method": "GET",
"profile": ""
}
],
"SiteNavigation:1052581735": {
"name": "Default",
"children": [
{
"start": "Page:1327351719456",
"Page:1327351719456": {
"name": "Home",
"children": [
{
"Page:1329851332601": {
"name": "Surfing",
"parents": []
},
"start": "Page:1329851332601"
},
{
"Page:1329326970440": {
"name": "Skiing",
"parents": []
},
"start": "Page:1329326970440"
},
{
"Page:1361217259137": {
"name": "Running",
"parents": []
},
"start": "Page:1361217259137"
},
{
"start": "Page:1327351719467",
"Page:1327351719467": {
"name": "Tennis",
"parents": []
}
},
{
"start": "Page:1327351719525",
"Page:1327351719525": {
"name": "Baseball",
"parents": []
}
}
],
"parents": []
}
}
],
"parents": []
}
}